Add docs for GtkStackSwitcher
authorMatthias Clasen <mclasen@redhat.com>
Sun, 21 Apr 2013 15:05:38 +0000 (11:05 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 22 Apr 2013 01:51:25 +0000 (21:51 -0400)
docs/reference/gtk/gtk-docs.sgml
docs/reference/gtk/gtk3-sections.txt
gtk/gtkstackswitcher.c

index 671c3b67d6b1722f857f8d153af38ab39a6f66c5..07d96a1dd90aa0c1062d3bcc9ebf5c5e76d60efc 100644 (file)
       <xi:include href="xml/gtkpaned.xml" />
       <xi:include href="xml/gtklayout.xml" />
       <xi:include href="xml/gtknotebook.xml" />
+      <xi:include href="xml/gtkstack.xml" />
+      <xi:include href="xml/gtkstackswitcher.xml" />
       <xi:include href="xml/gtkexpander.xml" />
       <xi:include href="xml/gtkoverlay.xml" />
       <xi:include href="xml/gtkheaderbar.xml" />
index 69ca8c860beafeaa95c9fb452411458853892205..2bf72f60fac5034445d4d69ce1949575e333148d 100644 (file)
@@ -7584,3 +7584,12 @@ GtkStackTransitionType
 gtk_stack_set_transition_type
 gtk_stack_get_transition_type
 </SECTION>
+
+<SECTION>
+<FILE>gtkstackswitcher</FILE>
+<TITLE>GtkStackSwitcher</TITLE>
+GtkStackSwitcher
+gtk_stack_switcher_new
+gtk_stack_switcher_set_stack
+gtk_stack_switcher_get_stack
+</SECTION>
index 3aef9ca3bb7f3bf82e1ae256deaef62e1ac9779d..d8a1030cd5ee69b6f373ac64c1c8124a93653934 100644 (file)
 #include "gtkprivate.h"
 #include "gtkintl.h"
 
+/**
+ * SECTION:gtkstackswitcher
+ * @Short_decription: A controller for GtkStack
+ * @Title: GtkStackSwitcher
+ * @See_also: #GtkStack
+ *
+ * The GtkStackSwitcher widget acts as a controller for a
+ * #GtkStack; it shows a row of buttons to switch between
+ * the various pages of the associated stack widget.
+ *
+ * All the content for the buttons comes from the child properties
+ * of the #GtkStack.
+ *
+ * It is possible to associate multiple #GtkStackSwitcher widgets
+ * with the same stack widget.
+ *
+ * The GtkStackSwitcher widget was added in 3.10.
+ */
+
 struct _GtkStackSwitcherPrivate
 {
   GtkStack *stack;
@@ -281,6 +300,8 @@ connect_stack_signals (GtkStackSwitcher *switcher)
  * @stack: (allow-none): a #GtkStack
  *
  * Sets the stack to control.
+ *
+ * Since: 3.10
  */
 void
 gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
@@ -320,11 +341,13 @@ gtk_stack_switcher_set_stack (GtkStackSwitcher *switcher,
  * gtk_stack_switcher_get_stack:
  * @switcher: a #GtkStackSwitcher
  *
- * Retrieves the stack. See
- * gtk_stack_switcher_set_stack().
+ * Retrieves the stack.
+ * See gtk_stack_switcher_set_stack().
  *
  * Return value: (transfer none): the stack, or %NULL if
  *    none has been set explicitly.
+ *
+ * Since: 3.10
  */
 GtkStack *
 gtk_stack_switcher_get_stack (GtkStackSwitcher *switcher)
@@ -406,6 +429,15 @@ gtk_stack_switcher_class_init (GtkStackSwitcherClass *class)
   g_type_class_add_private (object_class, sizeof (GtkStackSwitcherPrivate));
 }
 
+/**
+ * gtk_stack_switcher_new:
+ *
+ * Create a new #GtkStackSwitcher.
+ *
+ * Return value: a new #GtkStackSwitcher.
+ *
+ * Since: 3.10
+ */
 GtkWidget *
 gtk_stack_switcher_new (void)
 {